Adopt shared markdownlint config and lint-clean docs#162
Merged
Conversation
Carry the template's .markdownlint-cli2.jsonc verbatim so the davidanson IDE extension and CLI markdownlint-cli2 agree, and add jsonc to the .editorconfig JSON glob so the config file is CRLF-governed. Normalize blank lines around headings/fences/lists in copilot-instructions.md and label one fenced block so the repo passes cleanly under the shared config (0 errors). Realigns with ptr727/ProjectTemplate. Part of #160.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR realigns the repository’s Markdown linting and formatting rules with the shared template conventions by introducing a common markdownlint-cli2 configuration and adjusting existing docs/config to pass linting cleanly.
Changes:
- Added a repository-wide
.markdownlint-cli2.jsoncto standardize Markdown lint rules between IDE and CLI/CI. - Updated
.editorconfigto apply CRLF rules to both.jsonand.jsoncfiles. - Normalized Markdown spacing and labeled a previously-unlabeled fenced block in
.github/copilot-instructions.mdto satisfy the shared markdownlint rules.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
.markdownlint-cli2.jsonc |
Introduces shared markdownlint-cli2 configuration (with JSONC comments) to keep IDE/CLI rules aligned. |
.editorconfig |
Extends the JSON EOL rule to include JSONC files via [*.{json,jsonc}]. |
.github/copilot-instructions.md |
Markdown formatting adjustments (blank lines/fence labeling) to lint cleanly under the shared markdownlint config. |
This was referenced Jun 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part of #160 - realign with ptr727/ProjectTemplate.
.markdownlint-cli2.jsoncverbatim, so the davidansonmarkdownlintIDE extension and CLI/CImarkdownlint-cli2apply the same rules.jsoncto the.editorconfig[*.{json,jsonc}]glob so the new config file is CRLF-governed (matches the template)..github/copilot-instructions.mdand label one fenced block, so the repo passes cleanly under the shared config (markdownlint-cli2 "**/*.md"= 0 errors).Note: this repo's
.editorconfigalready carries the full per-extensionend_of_linerules (the realignment issue's "crlf only under[*.md]" claim was inaccurate on inspection), so no EOL-rule change was needed beyond the jsonc glob. The remaining item in #160 - renaming theDevelop/Mainrulesets to lowercasedevelop/main- is a repo-settings change handled separately.